Get information about the area
Retrieves information about the tariffs and extra options in a specific area.
The information is passed as coordinates lat and lon. If the coordinates are invalid, the "Zone not found" error is displayed.
The language can be changed with the Accept-Language parameter.
Request syntax
GET http://b2b-api.go.yandex.ru/integration/2.0/zoneinfo?lat=<latitude>&lon=<longitude>
Request headers
Authorization: Bearer <OAuth-token>
OAuth access token. The steps to get a token are described in Getting started.
X-YaTaxi-Selected-Corp-Client-Id— client ID from the account. Required if multiple clients are available using the token.
X-Request-Language: en
Request parameters
This request has the following required parameters:
-
lat: Latitude of the point in the area. -
lon: Longitude of the point in the area.
Response fields description
The response contains the following field:
| Field | Description | Format |
|---|---|---|
timezone_offset |
Time zone (offset). Example: "+0300". | String |
max_route_points_count |
Maximum number of route points. | Number |
country_code |
Country code. Example: "RU". | String |
currency_code |
Currency code. Example: "RUB". | String |
tariff_classes |
Array of tariffs. | Array |
timezone |
Часовой пояс (название). Пример: "Europe/Moscow". | String |
default_tariff_class |
Tariff class by default. | String |
client_cache_settings |
Client options stored in cache. JSON containing option names and values. | Object |
combo_orders_info |
Combined order data. | Object |
Structure of the tariff_classes array elements:
| Field | Description | Format |
|---|---|---|
name |
Tariff name (Latin script). | String |
name_translate |
Tariff name. | String |
supported_requirements |
Array of requirements. | Array of objects |
icon |
Link to the tariff class icon. | Object |
image |
Link to the tariff class image. | Object |
max_route_points_count |
Maximum number of route points. | Number |
has_extra_contact_phone |
Availability of an additional phone number. | Boolean |
req_destination |
Requirement to specify destination point. | Boolean |
Structure of the "link" object:
| Field | Description | Format |
|---|---|---|
url |
Link to the image. | String |
size_hint |
Maximum file size for images. | Number |
image_tag |
Image tag. | String |
url_parts |
An object containing the key field and the URL path segment after server address in path. |
Object |
Structure of the supported_requirements array elements:
| Field | Description | Format |
|---|---|---|
name |
Requirement name (Latin script). | String |
label |
Requirement name. | String |
glued |
Applies to select type preferences in tariffs. If set to true, the preference is pinned to the top of the summary card and becomes mandatory for selection before order creation. The Order button is locally disabled until the user selects a value. The field is not required if optional_glued: true is specified. |
Boolean |
type |
Requirement type. Possible values: select, boolean. |
String |
multiselect |
Used for tariff preferences where multiple selection is required. When set to true, the user can select multiple options from the list. Also sets limits on the maximum weight of selected options (max_weight) and the number of selected options (max_count). |
Boolean |
max_weight |
Maximum total weight of selected options. Used to limit selection when options have weights. For example, for child seats: - "Infant" seat may have weight 2. - "Chair" seat may have weight 2. - "Booster" may have weight 1. The total weight of selected options must not exceed the max_weight value. |
Number |
select |
Requirement description. Provided only for the requirements of the select type. |
Object |
Structure of the select object:
| Field | Description | Format |
|---|---|---|
options |
Requirement name (Latin script). | Array of objects |
type |
Value type. | String |
Structure of the options array element:
| Field | Description | Format |
|---|---|---|
name |
Option name (Latin script). | Array of objects |
label |
Name of the requirement the option is related to. | String |
title |
Option name. | String |
weight |
Weight. | Number |
max_count |
Maximum number of selectable options. Used when you need to limit the number of selected items, regardless of their weight. | Number |
value |
Option value. | Number |
Structure of the combo_orders_info object:
| Field | Description | Format |
|---|---|---|
allowed_vehicle_capacities |
Разрешенные количества пассажиров. | Массив чисел |
preselected_vehicle_capacity |
Количество пассаржиров по умолчанию. | Число |
Request example
GET http://b2b-api.go.yandex.ru/integration/2.0/zoneinfo?lat=32.093320&lon=34.798363
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>
Response example
An example response to this request looks like this:
{
"timezone_offset": "+0300",
"max_route_points_count": 5,
"country_code": "RU",
"currency_code": "RUB",
"tariff_classes": [
{
"name": "maybach",
"name_translate": "Elite",
"supported_requirements": [
{
"name": "door_to_door",
"label": "Door-to-door",
"glued": false,
"type": "boolean"
},
{
"name": "dont_open_door",
"label": "I'll open the door myself",
"glued": false,
"type": "boolean"
},
{
"name": "quiet_ride",
"label": "Quiet ride",
"glued": false,
"type": "boolean"
},
{
"name": "best_drivers",
"label": "High-rated drivers",
"glued": false,
"type": "boolean"
},
{
"name": "childchair_v2",
"label": "Child seat",
"glued": false,
"type": "select",
"multiselect": true,
"max_weight": 2.0,
"select": {
"options": [
{
"name": "infant",
"label": "9-18 kg",
"title": "Seat, 9 months to 4 years",
"weight": 1.0,
"max_count": 2,
"value": 1
},
{
"name": "chair",
"label": "15-25 kg",
"title": "Seat, 3-7 years",
"weight": 1.0,
"max_count": 2,
"value": 3
},
{
"name": "booster",
"label": "22-36 kg",
"title": "Booster, 6-12 years",
"weight": 1.0,
"max_count": 2,
"value": 7
}
],
"type": "number"
}
},
{
"name": "move_things",
"label": "Help with luggage, escort",
"glued": false,
"type": "boolean"
},
{
"name": "small_dog_animaltransport",
"label": "Small dog (up to 10 kg)",
"glued": false,
"type": "boolean"
},
{
"name": "big_dog_animaltransport",
"label": "Large dog (10+ kg)",
"glued": false,
"type": "boolean"
},
{
"name": "cat_animaltransport",
"label": "Cat",
"glued": false,
"type": "boolean"
},
{
"name": "other_animaltransport",
"label": "Other animal",
"glued": false,
"type": "boolean"
},
{
"name": "transfer",
"label": "Airport meet & greet",
"glued": false,
"type": "select",
"multiselect": false,
"select": {
"options": [
{
"name": "with_sign",
"label": "With sign",
"title": "With sign",
"value": 2
}
],
"type": "number"
}
}
],
"icon": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/c1ff75cc-3694-4cd6-b685-39aa001bd519",
"size_hint": 9999,
"image_tag": "class_maybach_icon_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/1138/c1ff75cc-3694-4cd6-b685-39aa001bd519"
}
},
"image": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/d7b2729525e642609a1d19c93553768e",
"size_hint": 9999,
"image_tag": "class_maybach_car_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/1138/d7b2729525e642609a1d19c93553768e"
}
},
"max_route_points_count": 5,
"has_extra_contact_phone": false,
"req_destination": false
},
{
"name": "lite_b2b",
"name_translate": "Lite",
"supported_requirements": [
{
"name": "transfer",
"label": "Airport meet & greet",
"glued": false,
"type": "select",
"multiselect": false,
"select": {
"options": [
{
"name": "with_sign",
"label": "With sign",
"title": "With sign",
"value": 2
},
{
"name": "no_sign",
"label": "Without sign",
"title": "Without sign",
"value": 1
}
],
"type": "number"
}
}
],
"icon": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/2426cf67de314daeb6add3223897455e",
"size_hint": 9999,
"image_tag": "class_lite_b2b_icon_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/1138/2426cf67de314daeb6add3223897455e"
}
},
"image": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/3ee2a298d16c4a399deb29eb0f20b7a3",
"size_hint": 9999,
"image_tag": "class_lite_b2b_car_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/1138/3ee2a298d16c4a399deb29eb0f20b7a3"
}
},
"max_route_points_count": 5,
"has_extra_contact_phone": false,
"req_destination": false
},
{
"name": "standart_b2b",
"name_translate": "Standard",
"supported_requirements": [
{
"name": "transfer",
"label": "Airport meet & greet",
"glued": false,
"type": "select",
"multiselect": false,
"select": {
"options": [
{
"name": "with_sign",
"label": "With sign",
"title": "With sign",
"value": 2
},
{
"name": "no_sign",
"label": "Without sign",
"title": "Without sign",
"value": 1
}
],
"type": "number"
}
}
],
"icon": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/598/edad66067be54c77b4606e9fb62d5691",
"size_hint": 9999,
"image_tag": "class_standart_b2b_icon_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/598/edad66067be54c77b4606e9fb62d5691"
}
},
"image": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/598/e983cd9ff0e14404aa4c6e1124fd561e",
"size_hint": 9999,
"image_tag": "class_standart_b2b_car_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/598/e983cd9ff0e14404aa4c6e1124fd561e"
}
},
"max_route_points_count": 5,
"has_extra_contact_phone": false,
"req_destination": false
},
{
"name": "optimum_b2b",
"name_translate": "Optimum",
"supported_requirements": [
{
"name": "transfer",
"label": "Airport meet & greet",
"glued": false,
"type": "select",
"multiselect": false,
"select": {
"options": [
{
"name": "with_sign",
"label": "With sign",
"title": "With sign",
"value": 2
},
{
"name": "no_sign",
"label": "Without sign",
"title": "Without sign",
"value": 1
}
],
"type": "number"
}
}
],
"icon": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/743/6f20f9fa000b4e178999bd7813094256",
"size_hint": 9999,
"image_tag": "class_optimum_b2b_icon_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/743/6f20f9fa000b4e178999bd7813094256"
}
},
"image": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/598/3e3afbb7c6ba4fce9589b015a78587f1",
"size_hint": 9999,
"image_tag": "class_optimum_b2b_car_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/598/3e3afbb7c6ba4fce9589b015a78587f1"
}
},
"max_route_points_count": 5,
"has_extra_contact_phone": false,
"req_destination": false
},
{
"name": "child_tariff",
"name_translate": "Child",
"supported_requirements": [
{
"name": "nosmoking",
"label": "Non-smoking driver",
"glued": false,
"type": "boolean"
},
{
"name": "childchair_v2",
"label": "Child seat",
"glued": true,
"type": "select",
"multiselect": true,
"max_weight": 2.0,
"select": {
"options": [
{
"name": "own_chair",
"label": " ",
"title": "Own seat",
"weight": 1.0,
"max_count": 1,
"value": 10
},
{
"name": "bassinet",
"label": "Up to 13 kg",
"title": "Bassinet, up to 1 year",
"weight": 2.0,
"max_count": 1,
"value": 11
},
{
"name": "infant",
"label": "9-18 kg",
"title": "Seat, 9 months to 4 years",
"weight": 1.0,
"max_count": 2,
"value": 1
},
{
"name": "chair",
"label": "15-25 kg",
"title": "Seat, 3-7 years",
"weight": 1.0,
"max_count": 2,
"value": 3
},
{
"name": "booster",
"label": "22-36 kg",
"title": "Booster, 6-12 years",
"weight": 1.0,
"max_count": 2,
"value": 7
}
],
"type": "number"
}
},
{
"name": "bicycle_other",
"label": "Bicycle",
"glued": false,
"type": "boolean"
},
{
"name": "move_things",
"label": "Help with luggage, escort",
"glued": false,
"type": "boolean"
}
],
"icon": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/598/068b87a6f82a457cb6b433e3e8820836",
"size_hint": 9999,
"image_tag": "class_child_tariff_icon_7_child_tariff",
"url_parts": {
"key": "TC",
"path": "/static/test-images/598/068b87a6f82a457cb6b433e3e8820836"
}
},
"image": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/743/88863bf078f24a22bc04f8e274111580",
"size_hint": 9999,
"image_tag": "class_child_tariff_car_7_child_tariff",
"url_parts": {
"key": "TC",
"path": "/static/test-images/743/88863bf078f24a22bc04f8e274111580"
}
},
"max_route_points_count": 5,
"has_extra_contact_phone": false,
"req_destination": false
},
{
"name": "ultimate",
"name_translate": "Premier",
"supported_requirements": [
{
"name": "animaltransport",
"label": "Pet transportation",
"glued": false,
"type": "boolean"
},
{
"name": "animaltransport",
"label": "Pet transportation",
"glued": false,
"type": "boolean"
},
{
"name": "dont_open_door",
"label": "I'll open the door myself",
"glued": false,
"type": "boolean"
},
{
"name": "quiet_ride",
"label": "Quiet ride",
"glued": false,
"type": "boolean"
},
{
"name": "childchair_v2",
"label": "Child seat",
"glued": true,
"type": "select",
"multiselect": true,
"max_weight": 3.0,
"select": {
"options": [
{
"name": "infant",
"label": "9-18 kg",
"title": "Seat, 9 months to 4 years",
"weight": 2.0,
"max_count": 1,
"value": 1
},
{
"name": "chair",
"label": "15-25 kg",
"title": "Seat, 3-7 years",
"weight": 2.0,
"max_count": 1,
"value": 3
},
{
"name": "booster",
"label": "22-36 kg",
"title": "Booster, 6-12 years",
"weight": 2.0,
"max_count": 1,
"value": 7
}
],
"type": "number"
}
}
],
"icon": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/3c459ceb-ffa3-40b5-9e86-1aa6c47c9e57",
"size_hint": 9999,
"image_tag": "class_ultimate_icon_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/1138/3c459ceb-ffa3-40b5-9e86-1aa6c47c9e57"
}
},
"image": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/743/d9550ffe029c4dfcbb68b8f1a00039ea",
"size_hint": 9999,
"image_tag": "class_ultimate_car_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/743/d9550ffe029c4dfcbb68b8f1a00039ea"
}
},
"max_route_points_count": 5,
"has_extra_contact_phone": false,
"req_destination": false
},
{
"name": "minivan",
"name_translate": "Minivan",
"supported_requirements": [
{
"name": "animaltransport",
"label": "Pet transportation",
"glued": false,
"type": "boolean"
},
{
"name": "bicycle",
"label": "Bicycle",
"glued": false,
"type": "boolean"
},
{
"name": "ski",
"label": "Skis or snowboard",
"glued": false,
"type": "boolean"
},
{
"name": "big_minivan",
"label": "Help with luggage",
"glued": false,
"type": "boolean"
},
{
"name": "childchair_v2",
"label": "Child seat",
"glued": false,
"type": "select",
"multiselect": true,
"max_weight": 3.0,
"select": {
"options": [
{
"name": "infant",
"label": "9-18 kg",
"title": "Seat, 9 months to 4 years",
"weight": 2.0,
"max_count": 1,
"value": 1
},
{
"name": "chair",
"label": "15-25 kg",
"title": "Seat, 3-7 years",
"weight": 2.0,
"max_count": 1,
"value": 3
},
{
"name": "booster",
"label": "22-36 kg",
"title": "Booster, 6-12 years",
"weight": 2.0,
"max_count": 1,
"value": 7
}
],
"type": "number"
}
}
],
"icon": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/743/8c618970936d434a8759543ed3d4cbb0",
"size_hint": 9999,
"image_tag": "class_minivan_icon_7_help_nearby",
"url_parts": {
"key": "TC",
"path": "/static/test-images/743/8c618970936d434a8759543ed3d4cbb0"
}
},
"image": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/fb410994120f424289661db21ad431d9",
"size_hint": 9999,
"image_tag": "class_minivan_car_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/1138/fb410994120f424289661db21ad431d9"
}
},
"max_route_points_count": 5,
"has_extra_contact_phone": false,
"req_destination": false
},
{
"name": "vip",
"name_translate": "Business",
"supported_requirements": [
{
"name": "has_conditioner",
"label": "Air conditioning",
"glued": false,
"type": "boolean"
},
{
"name": "dont_open_door",
"label": "I'll open the door myself",
"glued": false,
"type": "boolean"
},
{
"name": "animaltransport",
"label": "Pet transportation",
"glued": false,
"type": "boolean"
},
{
"name": "childchair_v2",
"label": "Child seat",
"glued": false,
"type": "select",
"multiselect": true,
"max_weight": 5.0,
"select": {
"options": [
{
"name": "infant",
"label": "9-18 kg",
"title": "Seat, 9 months to 4 years",
"weight": 3.0,
"max_count": 1,
"value": 1
},
{
"name": "chair",
"label": "15-25 kg",
"title": "Seat, 3-7 years",
"weight": 3.0,
"max_count": 1,
"value": 3
},
{
"name": "booster",
"label": "22-36 kg",
"title": "Booster, 6-12 years",
"weight": 2.0,
"max_count": 2,
"value": 7
}
],
"type": "number"
}
},
{
"name": "transfer",
"label": "Airport meet & greet",
"glued": false,
"type": "select",
"multiselect": false,
"select": {
"options": [
{
"name": "with_sign",
"label": "With sign",
"title": "With sign",
"value": 2
}
],
"type": "number"
}
}
],
"icon": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/743/f9a50577-63e5-4d39-98c6-69a992b83906",
"size_hint": 9999,
"image_tag": "class_vip_icon_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/743/f9a50577-63e5-4d39-98c6-69a992b83906"
}
},
"image": {
"url": "https://tc.tst.mobile.yandex.net/static/test-images/1138/31a482900a184aa6acb6991c43a62d29",
"size_hint": 9999,
"image_tag": "class_vip_car_7",
"url_parts": {
"key": "TC",
"path": "/static/test-images/1138/31a482900a184aa6acb6991c43a62d29"
}
},
"max_route_points_count": 6,
"has_extra_contact_phone": false,
"req_destination": false
}
],
"timezone": "Europe/Moscow",
"default_tariff_class": "maybach",
"client_cache_settings": {
"zones_max_count": 5,
"zone_ttl_sec": 864000
},
"combo_orders_info": {
"allowed_vehicle_capacities": [
3,
4,
6
],
"preselected_vehicle_capacity": 4
}
}
Response codes
The response to this request may contain the following HTTP codes:
200: Request completed successfully.400: Request contained an unknown parameter or a parameter with an invalid value.401: Incorrect OAuth-token passed.403: The client doesn't have sufficient rights to run this request.- SELECT_CLIENT_HEADER_REQUIRED: the request did not pass the header
X-YaTaxi-Selected-Corp-Client-Id(returned if more than one client is available for the token). - SELECTED_CLIENT_ACCESS_DENIED: the header
X-YaTaxi-Selected-Corp-Client-Idcontains the client's ID, which this login does not have access to.
- SELECT_CLIENT_HEADER_REQUIRED: the request did not pass the header
404: Area not found, issue on the client’s side.